<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Schema
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: OpenLdap.php 13453 2008-12-23 19:38:48Z sgehrig $
 */

/**
 * @see Zend_Ldap_Node_Schema_Item
 */
require_once 'Zend/Ldap/Node/Schema/Item.php';
/**
 * @see Zend_Ldap_Node_Schema_AttributeType_Interface
 */
require_once 'Zend/Ldap/Node/Schema/AttributeType/Interface.php';

/**
 * Zend_Ldap_Node_Schema_AttributeType_OpenLdap provides access to the attribute type
 * schema information on an OpenLDAP server.
 *
 * @category   Zend
 * @package    Zend_Ldap
 * @subpackage Schema
 * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Ldap_Node_Schema_AttributeType_OpenLdap extends Zend_Ldap_Node_Schema_Item
implements Zend_Ldap_Node_Schema_AttributeType_Interface
{
	/**
	 * Gets the attribute name
	 *
	 * @return string
	 */
	public function getName()
	{
		return $this->name;
	}

	/**
	 * Gets the attribute OID
	 *
	 * @return string
	 */
	public function getOid()
	{
		return $this->oid;
	}

	/**
	 * Gets the attribute syntax
	 *
	 * @return string
	 */
	public function getSyntax()
	{
		if ($this->syntax === null) {
			$parent = $this->getParent();
			if ($parent === null) return null;
			else return $parent->getSyntax();
		} else {
			return $this->syntax;
		}
	}

	/**
	 * Gets the attribute maximum length
	 *
	 * @return int|null
	 */
	public function getMaxLength()
	{
		$maxLength = $this->{'max-length'};
		if ($maxLength === null) {
			$parent = $this->getParent();
			if ($parent === null) return null;
			else return $parent->getMaxLength();
		} else {
			return (int)$maxLength;
		}
	}

	/**
	 * Returns if the attribute is single-valued.
	 *
	 * @return boolean
	 */
	public function isSingleValued()
	{
		return $this->{'single-value'};
	}

	/**
	 * Gets the attribute description
	 *
	 * @return string
	 */
	public function getDescription()
	{
		return $this->desc;
	}

	/**
	 * Returns the parent attribute type in the inhertitance tree if one exists
	 *
	 * @return Zend_Ldap_Node_Schema_AttributeType_OpenLdap|null
	 */
	public function getParent()
	{
		if (count($this->_parents) === 1) {
			return $this->_parents[0];
		}
	}
}